Configuring Agent Parameters

You can configure the parameters of an agent by changing the parameter values in the tagent.ini file. The tagent.ini file is located in the Unix agent directory. If the default location is used during the agent installation, the agent files are located at

/opt/TIDAL/Agent/bin.

Following is a tagent.ini file:

# =============================================
# Agent Configuration Information
# ===========================================
[config] agents=sun02,sun11,aix02,test degbug=yes
ovb=tidaldebug java=/usr/bin/ #sslvldcrt=n
sshvldhst=/home/secure/prd2_id_rsa.pub 
sslvldhst=/home/secure/vvm1.pem
[test] 
port=5915
java=<full-java-path>/bin 
minmem=32
maxmem=64 
logdays=5
[sun02] 
port=5915
java=<full-java-path>/bin 
sslvldcrt=n
[sun11] 
port=5915 
encryptonly=y
[aix02] 
port=5915
java=<full-java-path>/bin sslvldcrt=/home/secure/host.crt ulimitold=y

Restart the agent after modifying any of the agent’s parameters. You can set these agent parameters.

Parameter

Description

agtresource

 

Options for monitoring the agent resources at specified time intervals, in milliseconds (default=15000):

  • CPU: Monitors CPU usage

  • VMEM: Monitors virtual memory usage Setting this parameter takes the forms:

    agtresource=CPU;VMEM: Monitors both resources at the default 15-second intervals.

    agtresource=CPU,10000: Monitors only CPU usage at 10-second intervals.

    agtresource=CPU,10000;VMEM,20000: Monitors CPU usage at 10-second intervals and virtual memory usage at 20-second intervals.

The minimum interval is 5000 milliseconds, or 5 seconds.

Note: The Linux sysstat package must be installed to use this parameter.

cpuload

Whether to send agent system load information to the TA Master.

  • Y (default): Send load information to the TA Master at one-minute intervals.

  • N: Send no information.

Note: Enabling this parameter is typically useful only when an Agent List Definition sets the List Type field to a balanced option.

debug

Whether to enable low-level debugging of agent activity. Set the value to y to enable debugging.

DMBkupExistFile

Whether to backup an existing file when the Disposition Operation is set to Move file to target directory in the agent’s File Event Definition dialog. Valid values include:

  • Y: Create a new file with the same file name appended with the current timestamp in the Disposition Target directory.

  • N: Do not create a backup file.

Note: If DMBkupExistFile and DMRepExistFile are set to Y, the existing file is backed up. If these values are set to N and the file already exists, the file event will not trigger.

For more information about the disposition operation, see the Tidal Automation User Guide.

encryptonly

Whether to disable agent connections to any TA Master that disables message encryption. Valid values include N (default) and Y.

fp

 

Pathname of a file that defines environment variables for an agent instance, in the form: fp=/folder/file.

Each agent instance can be assigned its own environment file and its associated environment variables with their various values. Each variable specified in the environment file should follow a variable=value format as in these examples:

Example: TZ=CST
SchedulerT=1
PATH=/usr/sbin

ftptimeout

Timeout, in milliseconds, for an FTP connection. Setting the value to 0 results in no timeout for the connection.

homedir

 

Whether to use the agent’s home directory or the runtime user’s home directory as the working directory:

  • Y: Uses the runtime user’s home directory.

  • N or omitted (default): Uses the agent’s home directory (where the agent software is installed).

Note: Enabling this parameter overrides the working directory setting in the TA Master for all jobs to use the user’s home directory.

java

Path for the Java software.

jobkillwait

 

Time interval, in seconds, between sending a SIGTERM warning that a Unix job is about to be aborted and sending the SIGKILL signal to abort the job. Default = 5 seconds.

jobstopwait

Time interval, in seconds, between sending a SIGSTP warning that a Unix job is about to be put on hold and sending the SIGSTOP signal to pause the job. Default =1 second.

logdays

Number of days to preserve log files.

minmem/maxmem

Minimum and maximum RAM, in MB, to allocate for agent processes. Defaults: minmem=32, maxmem=256.

mreg

 

Paths to the agent properties files for agents that automatically register themselves with a TA Master, in the form: mreg=$HOME/agents/agent1.reg;$HOME/agents/agent2.reg

MstReconnect

Whether to reconnect to a TA Master automatically when the connection is lost. Possible values include:

  • Y (default): The agent automatically restores its connection to the TA Master.

  • N: The agent does not restore the connection. The TA Master must send a new registration message to restore the connection.

MSTTunnelConn

This parameter should only be set to "Y" in Tunneling environments where the master cannot communicate directly with the agent. The parameter should be specified in the specific Agent config section of the tagent.ini file in the ‘bin’ directory.

multiftpstd

 

How to handle FTP multi-file MGET, MPUT, or MDELETE actions that operate on no files. Values include:

  • Y (default): Allow the job to complete without reporting errors.

  • N: Allow the job to complete abnormally if the actions operated on no files.

ovb

Whether to enable maximum level of debug logging for agent activity. Set the value to "tidaldebug" to enable this logging.

Example: ovb=tidaldebug

profile

 

Whether to override the For Unix, source user’s profile setting on the Options tab of the Job Definition dialog:

  • Y: Causes the runtime user profile to be used for all jobs run on the agent.

  • N or omitted (default): Causes the runtime user profile to be used only for jobs whose definitions enable the setting.

SFTPCONFIGPATH

SFTP configuration file path. For more information, see the SFTP Functionality page.

SFTPMaxQReads

Maximum number of read requests to keep in the queue to decrease latencies in SFTP file transfers. Default=32.

Setting the value to 1 effectively turns off buffering of SFTP read requests. The SFTP client buffers 32 read requests by default. Buffering read requests improves performance by reducing the latency between read requests. Some FTP servers might not support buffered read requests properly, so this parameter allows you to disable or tune buffering to match server capabilities.

sftpparallelmode

Whether to enable parallel SFTP transfers. Default=Y.

sftpumask

Permission mask (4-digit octal) for files created on a Unix-based system with the SFTP PUT actions.

Default=0022.

sshvldhst

The location of ssh host file for authenticating hosts.

sslvldcrt

Whether to disable FTPS SSL certificate validation by Tidal Automation agents.

Default=Y.

Tidal Automation agents validate the host defined in FTPS SSL certificate. This host validation feature can be disabled by specifying a SSLVLDCRT parameter on the agent command line. The default is SSLVLDCRT=Y (yes). To turn off this parameter, specify SSLVLDCRT=N on the command line.

SVCTHRDTIMEOUT

Number of 5 minute periods before taking down TAU due to unresponsive File event thread. Default=1.

sslvldhst

 

Location of SSH host key file.

For SFTP host validation, the file location containing the public keys for servers with which the SFTP connections will be established.

The host key file provides a list of hosts and their associated public keys. The format of the file is similar to that used in OpenSSH. Each line contains the name of a host followed by its IP address (separated by a comma), the type of key it has, and its key (in base-64 printable form).

Example: jackspc,192.168.1.1 ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIE...

ulimitold

Toggles old ulimit configuration reading or not. Default=Y.

useoldencrypt

Whether to use older encryption methodologies that correctly handle most special characters. Default=N.

Note: You should enable this setting only when special characters in jobs or variables are causing issues. In this situation, please contact the Tidal Support Center before enabling the parameter.

vldhstcrt

Identical to SSLVLDCRT=Y. Default=Y.